/*
 * Copyright (c) 2011-2020, Peter Abeles. All Rights Reserved.
 *
 * This file is part of BoofCV (http://boofcv.org).
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package boofcv.alg.disparity.sgm;

/**
 * Various helper functions for computing SGM disparities.
 *
 * @author Peter Abeles
 */
public class SgmHelper {
	// Image width
	public int width;
	public int disparityMin;
	public int disparityRange;

	public void configure( int width, int disparityMin, int disparityRange ) {
		this.width = width;
		this.disparityMin = disparityMin;
		this.disparityRange = disparityRange;
	}

	/**
	 * Number of disparity values that can be considered for this x value along the left side of the image.
	 * Values greater than this are out of the right image bounds or greater than 'rangeDisparity'
	 */
	public final int localDisparityRangeLeft( int x ) {
		return Math.min(x - disparityMin + 1, disparityRange);
	}

	/**
	 * Same as {@link #localDisparityRangeLeft(int)} but for the right image boundary
	 */
	public final int localDisparityRangeRight( int x ) {
		return Math.min(width - x - disparityMin, disparityRange);
	}
}
